<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>Atom API Documentation</title>
  <link rel='stylesheet' href='../assets/biscotto.css' type='text/css'>
  <script src='../assets/biscotto.js'></script>
  <script src='../assets/search_data.js'></script>
</head>
  <body>
    <div id='base' data-path='..&#47;'></div>
<div id='header'>
  <div id='menu'>
    <a href='../docs/README.md.html' title='Atom'>Atom</a>
    &raquo;
    <a href='../class_index.html' title='Index'>Index</a>
    &raquo;
    <span class='title'>PackageManager</span>
    <nav>
      <ul>
        <li class='noframes'>
          (<a class='noframes' href='PackageManager.html#'>no frames</a>)
        </li>
      </ul>
    </nav>
    <div id='search'>
      <a id='class_list_link' href='../class_list.html'>Classes</a>
      <a id='file_list_link' href='../file_list.html'>Files</a>
      <a id='method_list_link' href='../method_list.html'>Methods</a>
      <a id='extra_list_link' href='../extra_list.html'>Extras</a>
    </div>
  </div>
  <iframe id='search_frame'></iframe>
  <div id='fuzzySearch'>
    <input type='text'>
    <ol></ol>
  </div>
  <div id='help'>
    <p>
      Quickly fuzzy find classes, mixins, methods, file:
    </p>
    <ul>
      <li>
        <span>Ctrl-T</span>
        Open fuzzy finder dialog
      </li>
    </ul>
    <p>
      In frame mode you can toggle the list naviation frame on the left side:
    </p>
    <ul>
      <li>
        <span>Ctrl-L</span>
        Toggle list view
      </li>
    </ul>
    <p>
      You can focus a list in frame mode or toggle a tab in frameless mode:
    </p>
    <ul>
      <li>
        <span>Ctrl-C</span>
        Class list
      </li>
      <li>
        <span>Ctrl-I</span>
        Mixin list
      </li>
      <li>
        <span>Ctrl-F</span>
        File list
      </li>
      <li>
        <span>Ctrl-M</span>
        Method list
      </li>
      <li>
        <span>Ctrl-E</span>
        Extras list
      </li>
    </ul>
    <p>
      You can focus and blur the search input:
    </p>
    <ul>
      <li>
        <span>Ctrl-S</span>
        Focus search input
      </li>
      <li>
        <span>Esc</span>
        Blur search input
      </li>
    </ul>
    <p>
      In frameless mode you can close the list tab:
    </p>
    <ul>
      <li>
        <span>Esc</span>
        Close list tab
      </li>
    </ul>
  </div>
</div>
    <div id='content'>
      <h1>
        Class
        PackageManager
      </h1>
      <div class='stability-1'>
        <span class='heading'></span>
        <div class='message'></div>
      </div>
      <table class='box'>
        <tr>
          <td>Defined in:</td>
          <td>src&#47;package-manager.coffee</td>
        </tr>
      </table>
      <h2>Overview</h2>
      <div class='docstring'>
  <p>Package manager for coordinating the lifecycle of Atom packages.</p><p>An instance of this class is always available as the <code>atom.packages</code> global.</p><p>Packages can be loaded, activated, and deactivated, and unloaded:</p><ul>
<li>Loading a package reads and parses the package&#39;s metadata and resources
such as keymaps, menus, stylesheets, etc.</li>
<li>Activating a package registers the loaded resources and calls <code>activate()</code>
on the package&#39;s main module.</li>
<li>Deactivating a package unregisters the package&#39;s resources  and calls
<code>deactivate()</code> on the package&#39;s main module.</li>
<li>Unloading a package removes it completely from the package manager.</li>
</ul><p>Packages can also be enabled/disabled via the <code>core.disabledPackages</code> config
settings and also by calling <code>enablePackage()/disablePackage()</code>. </p>
</div>
<div class='tags'>
</div>
      <h2>Instance Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#disablePackage-instance'>
        ::<strong>disablePackage</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Disable the package with the given name
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#enablePackage-instance'>
        ::<strong>enablePackage</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Enable the package with the given name
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getActivePackage-instance'>
        ::<strong>getActivePackage</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Get the active package with the given name
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getActivePackages-instance'>
        ::<strong>getActivePackages</strong>()
      </a>
    </span>
    <span class='desc'>
      Get an array of all the active packages
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getApmPath-instance'>
        ::<strong>getApmPath</strong>()
      </a>
    </span>
    <span class='desc'>
      Get the path to the apm command
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getAvailablePackageMetadata-instance'>
        ::<strong>getAvailablePackageMetadata</strong>()
      </a>
    </span>
    <span class='desc'>
      Get an array of all the available package metadata.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getAvailablePackageNames-instance'>
        ::<strong>getAvailablePackageNames</strong>()
      </a>
    </span>
    <span class='desc'>
      Get an array of all the available package names.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getAvailablePackagePaths-instance'>
        ::<strong>getAvailablePackagePaths</strong>()
      </a>
    </span>
    <span class='desc'>
      Get an array of all the available package paths.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getLoadedPackage-instance'>
        ::<strong>getLoadedPackage</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Get the loaded package with the given name
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getLoadedPackages-instance'>
        ::<strong>getLoadedPackages</strong>()
      </a>
    </span>
    <span class='desc'>
      Get an array of all the loaded packages
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#getPackageDirPaths-instance'>
        ::<strong>getPackageDirPaths</strong>()
      </a>
    </span>
    <span class='desc'>
      Get the paths being used to look for packages.
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#isBundledPackage-instance'>
        ::<strong>isBundledPackage</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Is the package with the given name bundled with Atom?
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#isPackageActive-instance'>
        ::<strong>isPackageActive</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Is the package with the given name active?
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#isPackageDisabled-instance'>
        ::<strong>isPackageDisabled</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Is the package with the given name disabled?
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#isPackageLoaded-instance'>
        ::<strong>isPackageLoaded</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Is the package with the given name loaded?
    </span>
  </li>
  <li>
    <span class='signature'>
      <a href='PackageManager.html#resolvePackagePath-instance'>
        ::<strong>resolvePackagePath</strong>(name)
      </a>
    </span>
    <span class='desc'>
      Resolve the given package name to a path on disk.
    </span>
  </li>
</ul>
      <h2>Instance Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='disablePackage-instance'>
      ::<strong>disablePackage</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Disable the package with the given name</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='enablePackage-instance'>
      ::<strong>enablePackage</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Enable the package with the given name</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getActivePackage-instance'>
      ::<strong>getActivePackage</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get the active package with the given name</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getActivePackages-instance'>
      ::<strong>getActivePackages</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get an array of all the active packages</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getApmPath-instance'>
      ::<strong>getApmPath</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get the path to the apm command</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getAvailablePackageMetadata-instance'>
      ::<strong>getAvailablePackageMetadata</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get an array of all the available package metadata.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getAvailablePackageNames-instance'>
      ::<strong>getAvailablePackageNames</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get an array of all the available package names.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getAvailablePackagePaths-instance'>
      ::<strong>getAvailablePackagePaths</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get an array of all the available package paths.</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getLoadedPackage-instance'>
      ::<strong>getLoadedPackage</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get the loaded package with the given name</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getLoadedPackages-instance'>
      ::<strong>getLoadedPackages</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get an array of all the loaded packages</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='getPackageDirPaths-instance'>
      ::<strong>getPackageDirPaths</strong>()
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Get the paths being used to look for packages.</p>
</div>
<div class='tags'>
  <h3>Returns:</h3>
  <ul class='return'>
    <li>
      <span class='type'></span>
      <span class='desc'>Returns an Array of String directory paths.</span>
    </li>
  </ul>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isBundledPackage-instance'>
      ::<strong>isBundledPackage</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Is the package with the given name bundled with Atom?</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isPackageActive-instance'>
      ::<strong>isPackageActive</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Is the package with the given name active?</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isPackageDisabled-instance'>
      ::<strong>isPackageDisabled</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Is the package with the given name disabled?</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='isPackageLoaded-instance'>
      ::<strong>isPackageLoaded</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Is the package with the given name loaded?</p>
</div>
<div class='tags'>
</div>
  </div>
  <div class='method_details'>
    <p class='signature' id='resolvePackagePath-instance'>
      ::<strong>resolvePackagePath</strong>(name)
      <a class='gh-link' href='https://github.com/atom/atom'>Source</a>
    </p>
    <div class='docstring'>
  <p>Resolve the given package name to a path on disk.</p>
</div>
<div class='tags'>
</div>
  </div>
</div>
    </div>
    <div id='footer'>
  Generated on
  Wed Mar 05 2014 08:55:13 GMT-0700 (MST)
  by
  <a href='https://github.com/gjtorikian/biscotto' title='TomDoc-CoffeeScript API documentation generator'>Biscotto</a>
  v2.1.1
  (Node.js v0.10.22).
  &#10034;
  Press Ctrl-h to see the keyboard shortcuts
</div>
  </body>
</html>